// --------------------------------------------------------------------------------------------------------------------
// <copyright file="CodeCoverageAgent.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Test.Robotics.Runtime
{
    using System;
    using System.Runtime.Serialization;
    using Microsoft.Robotics.Runtime;

    /// <summary>
    /// CodeCoverageAgent used just to get code coverage
    /// </summary>
    [DataContract]
    public class CodeCoverageAgent : ProducerAgent<AgentMessage>
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="CodeCoverageAgent"/> class. 
        /// Creates a new instance of the CodeCoverageAgent class.
        /// </summary>
        public CodeCoverageAgent()
            : base()
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CodeCoverageAgent"/> class. 
        /// Creates a new instance of the CodeCoverageAgent class.
        /// </summary>
        /// <param name="name">Our name</param>
        public CodeCoverageAgent(string name)
            : base(name)
        {
        }

        /// <summary>
        /// Get the agent locator to exercise code coverage
        /// </summary>
        public void TestGetLocator()
        {
            AgentLocator locator = this.Locator;
            if (locator == null)
            {
                throw new Exception("locator field is null");
            }
        }

        /// <summary>
        /// Initialize this agent
        /// </summary>
        /// <param name="locator">The agent locator</param>
        public override void Initialize(AgentLocator locator)
        {
            base.Initialize(locator);
        }

        /// <summary>
        /// Activate this agent
        /// </summary>
        public override void OnActivated()
        {
            base.OnActivated();
        }

        /// <summary>
        /// Deactivate this agent
        /// </summary>
        public override void OnDeactivated()
        {
            base.OnDeactivated();
        }
    }
}
